Endpoint Diagnostics
Route
/v2/endpoint-management/endpoints/{id}/diagnostics
Description
List, request, or delete diagnostic captures for a specific endpoint.
Methods
- GET — list available diagnostics for the endpoint
- POST — request a new diagnostic capture
- DELETE — delete diagnostics for the endpoint
Inputs
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Endpoint ID in the path |
type | DiagnosticType | Yes (POST) | Diagnostic type to collect (for example logs, sysdiag, perf) |
force | boolean | No (POST) | Create a new capture even if one already exists |
Request Example (POST)
{
"type": "logs",
"force": true
}
Output (GET/POST)
| Field | Type | Description |
|---|---|---|
type | string | Always "diagnostics" |
size | integer | Number of diagnostics returned |
resources | array[Diagnostic] | Diagnostic objects |
errors | array[Error] | Any errors |
Diagnostic Object (key fields)
| Field | Type | Description |
|---|---|---|
endpoint_id | string | Endpoint ID |
sequence | integer | Diagnostic sequence number |
type | string | Diagnostic type |
status | string | Diagnostic status (pending, completed, error) |
error | string | Error message when status is error |
Rate Limit
- 60 requests per minute per API key
- 5 concurrent requests per endpoint
Example Response (GET)
{
"type": "diagnostics",
"size": 1,
"resources": [
{
"endpoint_id": "endpoint-6fcd9b90-41f7-4ed6-a3a1-9fd6efb7c9aa",
"sequence": 1,
"type": "logs",
"status": "completed"
}
],
"errors": []
}